Add interactive Python REPL playground to docs#51
Draft
chrizzFTD wants to merge 6 commits into
Draft
Conversation
Integrate sphinx-pyrepl-web with a new Playground page that embeds a Pyodide REPL preloading grill-usd-core, grill-names, and grill. The replay session walks through the end-to-end cook workflow from the documentation examples. Also bump documented version to 0.19.1 and pin sphinx>=9 for the new extension dependency. Co-authored-by: chrizzftd <chrizzFTD@users.noreply.github.com>
Co-authored-by: chrizzftd <chrizzFTD@users.noreply.github.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #51 +/- ##
========================================
Coverage 89.37% 89.37%
========================================
Files 13 13
Lines 3088 3088
========================================
Hits 2760 2760
Misses 328 328 🚀 New features to boost your workflow:
|
Enable interactive doctest REPLs on API pages via the :project: sentinel, which auto-builds the grill wheel at doc-build time. Augment resolved packages with grill-usd-core and grill-names for browser WASM compatibility. Follows sphinx-pyrepl-web PR #25 and grill-names PR #35 patterns. Co-authored-by: chrizzftd <chrizzFTD@users.noreply.github.com>
Drop custom REPL sizing rules and the _augment_pyrepl_packages conf.py hook; extra autodoc package deps should be handled upstream in sphinx-pyrepl-web. Co-authored-by: chrizzftd <chrizzFTD@users.noreply.github.com>
Pin docs extra to the PR branch and use combined package specs for autodoc REPLs and the playground directive, replacing the removed conf.py augmentation hook and pinned PyPI grill version. Validated: docs build succeeds; playground and api.html emit REPLs preloading the auto-built grill wheel plus grill-usd-core and grill-names. Co-authored-by: chrizzftd <chrizzFTD@users.noreply.github.com>
Project root is auto-detected by walking up from docs/source/ to the repo root (setup.cfg). Explicit override was unnecessary. Co-authored-by: chrizzftd <chrizzFTD@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a Playground documentation page with an embedded Pyodide REPL via
sphinx-pyrepl-web, plus interactive autodoc REPLs on API pages.Uses sphinx-pyrepl-web PR #26 (0.4.1) for comma-separated
:project:package lists — no customconf.pyhooks required.Changes
sphinx-pyrepl-webto PR Create Many #26 branch (cursor/project-package-lists-370c) for QC; switch to>=0.4.1once releasedgrill):project:sentinel into_static/wheels/playgroundto the toctree; sync documented version to0.19.1QC validation (PR #26)
sphinx-pyrepl-web0.4.1 installs from PR branch_static/wheels/grill-0.19.1-py3-none-any.whlplayground.html—:project:resolved in directive:packages::api.html— 3 autodoc REPLs with same combined package list + bootstrap scriptsNotes
Once sphinx-pyrepl-web 0.4.1 lands on PyPI, replace the git URL in
setup.cfgwithsphinx-pyrepl-web>=0.4.1.